IH-642: Restructure xs-trace to use Cmdliner #5778
Conversation
|
Marking this as ready for review. These changes are pretty isolated but I suspect there will be some suggestions for better descriptions of the arguments, commands, man page, etc. I've tested this on a host manually and it seems to work. |
|
Pushed a fixup commit to address review comments. |
|
Thanks for the reviews. I've added the "don't merge yet" label as I think it would be good to run a test case, if possible (although I'm unsure if the sequence file describes tests that can easily be made to run). That said, testing was done from a host and all was working fine. I'll address the other review comments soon. |
The xs-trace utility is restructured to enhance its readability and, to aid with potential future extension, its CLI is reimplemented in terms of Cmdliner. It is hoped that the current command modes are consistent with what was already expected by xs-trace, i.e. xs-trace (cp|mv) <src> <endpoint> These changes should make it simpler to extend this utility with more functionality. For example, there is an idea to add some short conversion routines from Zipkinv2 to Google's Catapult trace format - so that single host triaging can bypass heavy distributed tracing services and use functionality built into Chrome (or the online Perfetto trace viewer). Signed-off-by: Colin James <colin.barr@cloud.com>
|
Rebased so I could squash the review fixups. |
|
Please merge this. |
The xs-trace utility is restructured to enhance its readability and, to aid with potential future extension, its CLI is reimplemented in terms of Cmdliner.
It is hoped that the current command modes are consistent with what was already expected by xs-trace, i.e. xs-trace (cp|mv)
These changes should make it simpler to extend this utility with more functionality. For example, there is an idea to add some short conversion routines from Zipkinv2 to Google's Catapult trace format - so that single host triaging can bypass heavy distributed tracing services and use functionality built into Chrome (or the online Perfetto trace viewer).